<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>SubsetConfiguration xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/commons/configuration/SubsetConfiguration.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> * the License.  You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> *     <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> org.apache.commons.configuration;
<a class="jxr_linenumber" name="19" href="#19">19</a>  
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a class="jxr_linenumber" name="21" href="#21">21</a>  
<a class="jxr_linenumber" name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.interpol.ConfigurationInterpolator;
<a class="jxr_linenumber" name="23" href="#23">23</a>  
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;A subset of another configuration. The new Configuration object contains</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * every key from the parent Configuration that starts with prefix. The prefix</em>
<a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * is removed from the keys in the subset.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;It is usually not necessary to use this class directly. Instead the</em>
<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * {@link Configuration#subset(String)} method should be used,</em>
<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * which will return a correctly initialized instance.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * @author Emmanuel Bourg</em>
<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * @version $Id: SubsetConfiguration.java 1210202 2011-12-04 20:30:46Z oheger $</em>
<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="35" href="#35">35</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/SubsetConfiguration.html">SubsetConfiguration</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/commons/configuration/AbstractConfiguration.html">AbstractConfiguration</a>
<a class="jxr_linenumber" name="36" href="#36">36</a>  {
<a class="jxr_linenumber" name="37" href="#37">37</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The parent configuration. */</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>      <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> parent;
<a class="jxr_linenumber" name="39" href="#39">39</a>  
<a class="jxr_linenumber" name="40" href="#40">40</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The prefix used to select the properties. */</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>      <strong class="jxr_keyword">protected</strong> String prefix;
<a class="jxr_linenumber" name="42" href="#42">42</a>  
<a class="jxr_linenumber" name="43" href="#43">43</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The prefix delimiter */</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>      <strong class="jxr_keyword">protected</strong> String delimiter;
<a class="jxr_linenumber" name="45" href="#45">45</a>  
<a class="jxr_linenumber" name="46" href="#46">46</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     * Create a subset of the specified configuration</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     * @param parent The parent configuration</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     * @param prefix The prefix used to select the properties</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/SubsetConfiguration.html">SubsetConfiguration</a>(<a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> parent, String prefix)
<a class="jxr_linenumber" name="53" href="#53">53</a>      {
<a class="jxr_linenumber" name="54" href="#54">54</a>          <strong class="jxr_keyword">this</strong>.parent = parent;
<a class="jxr_linenumber" name="55" href="#55">55</a>          <strong class="jxr_keyword">this</strong>.prefix = prefix;
<a class="jxr_linenumber" name="56" href="#56">56</a>      }
<a class="jxr_linenumber" name="57" href="#57">57</a>  
<a class="jxr_linenumber" name="58" href="#58">58</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     * Create a subset of the specified configuration</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * @param parent    The parent configuration</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * @param prefix    The prefix used to select the properties</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * @param delimiter The prefix delimiter</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/SubsetConfiguration.html">SubsetConfiguration</a>(<a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> parent, String prefix, String delimiter)
<a class="jxr_linenumber" name="66" href="#66">66</a>      {
<a class="jxr_linenumber" name="67" href="#67">67</a>          <strong class="jxr_keyword">this</strong>.parent = parent;
<a class="jxr_linenumber" name="68" href="#68">68</a>          <strong class="jxr_keyword">this</strong>.prefix = prefix;
<a class="jxr_linenumber" name="69" href="#69">69</a>          <strong class="jxr_keyword">this</strong>.delimiter = delimiter;
<a class="jxr_linenumber" name="70" href="#70">70</a>      }
<a class="jxr_linenumber" name="71" href="#71">71</a>  
<a class="jxr_linenumber" name="72" href="#72">72</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * Return the key in the parent configuration associated to the specified</em>
<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * key in this subset.</em>
<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * @param key The key in the subset.</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * @return the key as to be used by the parent</em>
<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="79" href="#79">79</a>      <strong class="jxr_keyword">protected</strong> String getParentKey(String key)
<a class="jxr_linenumber" name="80" href="#80">80</a>      {
<a class="jxr_linenumber" name="81" href="#81">81</a>          <strong class="jxr_keyword">if</strong> (<span class="jxr_string">""</span>.equals(key) || key == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="82" href="#82">82</a>          {
<a class="jxr_linenumber" name="83" href="#83">83</a>              <strong class="jxr_keyword">return</strong> prefix;
<a class="jxr_linenumber" name="84" href="#84">84</a>          }
<a class="jxr_linenumber" name="85" href="#85">85</a>          <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="86" href="#86">86</a>          {
<a class="jxr_linenumber" name="87" href="#87">87</a>              <strong class="jxr_keyword">return</strong> delimiter == <strong class="jxr_keyword">null</strong> ? prefix + key : prefix + delimiter + key;
<a class="jxr_linenumber" name="88" href="#88">88</a>          }
<a class="jxr_linenumber" name="89" href="#89">89</a>      }
<a class="jxr_linenumber" name="90" href="#90">90</a>  
<a class="jxr_linenumber" name="91" href="#91">91</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * Return the key in the subset configuration associated to the specified</em>
<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * key in the parent configuration.</em>
<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * @param key The key in the parent configuration.</em>
<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     * @return the key in the context of this subset configuration</em>
<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="98" href="#98">98</a>      <strong class="jxr_keyword">protected</strong> String getChildKey(String key)
<a class="jxr_linenumber" name="99" href="#99">99</a>      {
<a class="jxr_linenumber" name="100" href="#100">100</a>         <strong class="jxr_keyword">if</strong> (!key.startsWith(prefix))
<a class="jxr_linenumber" name="101" href="#101">101</a>         {
<a class="jxr_linenumber" name="102" href="#102">102</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"The parent key '"</span> + key + <span class="jxr_string">"' is not in the subset."</span>);
<a class="jxr_linenumber" name="103" href="#103">103</a>         }
<a class="jxr_linenumber" name="104" href="#104">104</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="105" href="#105">105</a>         {
<a class="jxr_linenumber" name="106" href="#106">106</a>             String modifiedKey = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="107" href="#107">107</a>             <strong class="jxr_keyword">if</strong> (key.length() == prefix.length())
<a class="jxr_linenumber" name="108" href="#108">108</a>             {
<a class="jxr_linenumber" name="109" href="#109">109</a>                 modifiedKey = <span class="jxr_string">""</span>;
<a class="jxr_linenumber" name="110" href="#110">110</a>             }
<a class="jxr_linenumber" name="111" href="#111">111</a>             <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="112" href="#112">112</a>             {
<a class="jxr_linenumber" name="113" href="#113">113</a>                 <strong class="jxr_keyword">int</strong> i = prefix.length() + (delimiter != <strong class="jxr_keyword">null</strong> ? delimiter.length() : 0);
<a class="jxr_linenumber" name="114" href="#114">114</a>                 modifiedKey = key.substring(i);
<a class="jxr_linenumber" name="115" href="#115">115</a>             }
<a class="jxr_linenumber" name="116" href="#116">116</a> 
<a class="jxr_linenumber" name="117" href="#117">117</a>             <strong class="jxr_keyword">return</strong> modifiedKey;
<a class="jxr_linenumber" name="118" href="#118">118</a>         }
<a class="jxr_linenumber" name="119" href="#119">119</a>     }
<a class="jxr_linenumber" name="120" href="#120">120</a> 
<a class="jxr_linenumber" name="121" href="#121">121</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * Return the parent configuration for this subset.</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * @return the parent configuration</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="126" href="#126">126</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> getParent()
<a class="jxr_linenumber" name="127" href="#127">127</a>     {
<a class="jxr_linenumber" name="128" href="#128">128</a>         <strong class="jxr_keyword">return</strong> parent;
<a class="jxr_linenumber" name="129" href="#129">129</a>     }
<a class="jxr_linenumber" name="130" href="#130">130</a> 
<a class="jxr_linenumber" name="131" href="#131">131</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment">     * Return the prefix used to select the properties in the parent configuration.</em>
<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * @return the prefix used by this subset</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="136" href="#136">136</a>     <strong class="jxr_keyword">public</strong> String getPrefix()
<a class="jxr_linenumber" name="137" href="#137">137</a>     {
<a class="jxr_linenumber" name="138" href="#138">138</a>         <strong class="jxr_keyword">return</strong> prefix;
<a class="jxr_linenumber" name="139" href="#139">139</a>     }
<a class="jxr_linenumber" name="140" href="#140">140</a> 
<a class="jxr_linenumber" name="141" href="#141">141</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * Set the prefix used to select the properties in the parent configuration.</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment">     * @param prefix the prefix</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="146" href="#146">146</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPrefix(String prefix)
<a class="jxr_linenumber" name="147" href="#147">147</a>     {
<a class="jxr_linenumber" name="148" href="#148">148</a>         <strong class="jxr_keyword">this</strong>.prefix = prefix;
<a class="jxr_linenumber" name="149" href="#149">149</a>     }
<a class="jxr_linenumber" name="150" href="#150">150</a> 
<a class="jxr_linenumber" name="151" href="#151">151</a>     @Override
<a class="jxr_linenumber" name="152" href="#152">152</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> subset(String prefix)
<a class="jxr_linenumber" name="153" href="#153">153</a>     {
<a class="jxr_linenumber" name="154" href="#154">154</a>         <strong class="jxr_keyword">return</strong> parent.subset(getParentKey(prefix));
<a class="jxr_linenumber" name="155" href="#155">155</a>     }
<a class="jxr_linenumber" name="156" href="#156">156</a> 
<a class="jxr_linenumber" name="157" href="#157">157</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEmpty()
<a class="jxr_linenumber" name="158" href="#158">158</a>     {
<a class="jxr_linenumber" name="159" href="#159">159</a>         <strong class="jxr_keyword">return</strong> !getKeys().hasNext();
<a class="jxr_linenumber" name="160" href="#160">160</a>     }
<a class="jxr_linenumber" name="161" href="#161">161</a> 
<a class="jxr_linenumber" name="162" href="#162">162</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> containsKey(String key)
<a class="jxr_linenumber" name="163" href="#163">163</a>     {
<a class="jxr_linenumber" name="164" href="#164">164</a>         <strong class="jxr_keyword">return</strong> parent.containsKey(getParentKey(key));
<a class="jxr_linenumber" name="165" href="#165">165</a>     }
<a class="jxr_linenumber" name="166" href="#166">166</a> 
<a class="jxr_linenumber" name="167" href="#167">167</a>     @Override
<a class="jxr_linenumber" name="168" href="#168">168</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addPropertyDirect(String key, Object value)
<a class="jxr_linenumber" name="169" href="#169">169</a>     {
<a class="jxr_linenumber" name="170" href="#170">170</a>         parent.addProperty(getParentKey(key), value);
<a class="jxr_linenumber" name="171" href="#171">171</a>     }
<a class="jxr_linenumber" name="172" href="#172">172</a> 
<a class="jxr_linenumber" name="173" href="#173">173</a>     @Override
<a class="jxr_linenumber" name="174" href="#174">174</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> clearPropertyDirect(String key)
<a class="jxr_linenumber" name="175" href="#175">175</a>     {
<a class="jxr_linenumber" name="176" href="#176">176</a>         parent.clearProperty(getParentKey(key));
<a class="jxr_linenumber" name="177" href="#177">177</a>     }
<a class="jxr_linenumber" name="178" href="#178">178</a> 
<a class="jxr_linenumber" name="179" href="#179">179</a>     <strong class="jxr_keyword">public</strong> Object getProperty(String key)
<a class="jxr_linenumber" name="180" href="#180">180</a>     {
<a class="jxr_linenumber" name="181" href="#181">181</a>         <strong class="jxr_keyword">return</strong> parent.getProperty(getParentKey(key));
<a class="jxr_linenumber" name="182" href="#182">182</a>     }
<a class="jxr_linenumber" name="183" href="#183">183</a> 
<a class="jxr_linenumber" name="184" href="#184">184</a>     @Override
<a class="jxr_linenumber" name="185" href="#185">185</a>     <strong class="jxr_keyword">public</strong> Iterator&lt;String&gt; getKeys(String prefix)
<a class="jxr_linenumber" name="186" href="#186">186</a>     {
<a class="jxr_linenumber" name="187" href="#187">187</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/SubsetConfiguration.html">SubsetIterator</a>(parent.getKeys(getParentKey(prefix)));
<a class="jxr_linenumber" name="188" href="#188">188</a>     }
<a class="jxr_linenumber" name="189" href="#189">189</a> 
<a class="jxr_linenumber" name="190" href="#190">190</a>     <strong class="jxr_keyword">public</strong> Iterator&lt;String&gt; getKeys()
<a class="jxr_linenumber" name="191" href="#191">191</a>     {
<a class="jxr_linenumber" name="192" href="#192">192</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/SubsetConfiguration.html">SubsetIterator</a>(parent.getKeys(prefix));
<a class="jxr_linenumber" name="193" href="#193">193</a>     }
<a class="jxr_linenumber" name="194" href="#194">194</a> 
<a class="jxr_linenumber" name="195" href="#195">195</a>     @Override
<a class="jxr_linenumber" name="196" href="#196">196</a>     <strong class="jxr_keyword">protected</strong> Object interpolate(Object base)
<a class="jxr_linenumber" name="197" href="#197">197</a>     {
<a class="jxr_linenumber" name="198" href="#198">198</a>         <strong class="jxr_keyword">if</strong> (delimiter == <strong class="jxr_keyword">null</strong> &amp;&amp; <span class="jxr_string">""</span>.equals(prefix))
<a class="jxr_linenumber" name="199" href="#199">199</a>         {
<a class="jxr_linenumber" name="200" href="#200">200</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.interpolate(base);
<a class="jxr_linenumber" name="201" href="#201">201</a>         }
<a class="jxr_linenumber" name="202" href="#202">202</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="203" href="#203">203</a>         {
<a class="jxr_linenumber" name="204" href="#204">204</a>             <a href="../../../../org/apache/commons/configuration/SubsetConfiguration.html">SubsetConfiguration</a> config = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/SubsetConfiguration.html">SubsetConfiguration</a>(parent, <span class="jxr_string">""</span>);
<a class="jxr_linenumber" name="205" href="#205">205</a>             <a href="../../../../org/apache/commons/configuration/interpol/ConfigurationInterpolator.html">ConfigurationInterpolator</a> interpolator = config.getInterpolator();
<a class="jxr_linenumber" name="206" href="#206">206</a>             getInterpolator().registerLocalLookups(interpolator);
<a class="jxr_linenumber" name="207" href="#207">207</a>             <strong class="jxr_keyword">if</strong> (parent instanceof AbstractConfiguration)
<a class="jxr_linenumber" name="208" href="#208">208</a>             {
<a class="jxr_linenumber" name="209" href="#209">209</a>                 interpolator.setParentInterpolator(((AbstractConfiguration) parent).getInterpolator());
<a class="jxr_linenumber" name="210" href="#210">210</a>             }
<a class="jxr_linenumber" name="211" href="#211">211</a>             <strong class="jxr_keyword">return</strong> config.interpolate(base);
<a class="jxr_linenumber" name="212" href="#212">212</a>         }
<a class="jxr_linenumber" name="213" href="#213">213</a>     }
<a class="jxr_linenumber" name="214" href="#214">214</a> 
<a class="jxr_linenumber" name="215" href="#215">215</a>     @Override
<a class="jxr_linenumber" name="216" href="#216">216</a>     <strong class="jxr_keyword">protected</strong> String interpolate(String base)
<a class="jxr_linenumber" name="217" href="#217">217</a>     {
<a class="jxr_linenumber" name="218" href="#218">218</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.interpolate(base);
<a class="jxr_linenumber" name="219" href="#219">219</a>     }
<a class="jxr_linenumber" name="220" href="#220">220</a> 
<a class="jxr_linenumber" name="221" href="#221">221</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="222" href="#222">222</a> <em class="jxr_javadoccomment">     * {@inheritDoc}</em>
<a class="jxr_linenumber" name="223" href="#223">223</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * Change the behavior of the parent configuration if it supports this feature.</em>
<a class="jxr_linenumber" name="225" href="#225">225</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="226" href="#226">226</a>     @Override
<a class="jxr_linenumber" name="227" href="#227">227</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setThrowExceptionOnMissing(<strong class="jxr_keyword">boolean</strong> throwExceptionOnMissing)
<a class="jxr_linenumber" name="228" href="#228">228</a>     {
<a class="jxr_linenumber" name="229" href="#229">229</a>         <strong class="jxr_keyword">if</strong> (parent instanceof AbstractConfiguration)
<a class="jxr_linenumber" name="230" href="#230">230</a>         {
<a class="jxr_linenumber" name="231" href="#231">231</a>             ((<a href="../../../../org/apache/commons/configuration/AbstractConfiguration.html">AbstractConfiguration</a>) parent).setThrowExceptionOnMissing(throwExceptionOnMissing);
<a class="jxr_linenumber" name="232" href="#232">232</a>         }
<a class="jxr_linenumber" name="233" href="#233">233</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="234" href="#234">234</a>         {
<a class="jxr_linenumber" name="235" href="#235">235</a>             <strong class="jxr_keyword">super</strong>.setThrowExceptionOnMissing(throwExceptionOnMissing);
<a class="jxr_linenumber" name="236" href="#236">236</a>         }
<a class="jxr_linenumber" name="237" href="#237">237</a>     }
<a class="jxr_linenumber" name="238" href="#238">238</a> 
<a class="jxr_linenumber" name="239" href="#239">239</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="240" href="#240">240</a> <em class="jxr_javadoccomment">     * {@inheritDoc}</em>
<a class="jxr_linenumber" name="241" href="#241">241</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="242" href="#242">242</a> <em class="jxr_javadoccomment">     * The subset inherits this feature from its parent if it supports this feature.</em>
<a class="jxr_linenumber" name="243" href="#243">243</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="244" href="#244">244</a>     @Override
<a class="jxr_linenumber" name="245" href="#245">245</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isThrowExceptionOnMissing()
<a class="jxr_linenumber" name="246" href="#246">246</a>     {
<a class="jxr_linenumber" name="247" href="#247">247</a>         <strong class="jxr_keyword">if</strong> (parent instanceof AbstractConfiguration)
<a class="jxr_linenumber" name="248" href="#248">248</a>         {
<a class="jxr_linenumber" name="249" href="#249">249</a>             <strong class="jxr_keyword">return</strong> ((AbstractConfiguration) parent).isThrowExceptionOnMissing();
<a class="jxr_linenumber" name="250" href="#250">250</a>         }
<a class="jxr_linenumber" name="251" href="#251">251</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="252" href="#252">252</a>         {
<a class="jxr_linenumber" name="253" href="#253">253</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.isThrowExceptionOnMissing();
<a class="jxr_linenumber" name="254" href="#254">254</a>         }
<a class="jxr_linenumber" name="255" href="#255">255</a>     }
<a class="jxr_linenumber" name="256" href="#256">256</a> 
<a class="jxr_linenumber" name="257" href="#257">257</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_javadoccomment">     * Returns the list delimiter. This property will be fetched from the parent</em>
<a class="jxr_linenumber" name="259" href="#259">259</a> <em class="jxr_javadoccomment">     * configuration if supported.</em>
<a class="jxr_linenumber" name="260" href="#260">260</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="261" href="#261">261</a> <em class="jxr_javadoccomment">     * @return the list delimiter</em>
<a class="jxr_linenumber" name="262" href="#262">262</a> <em class="jxr_javadoccomment">     * @since 1.4</em>
<a class="jxr_linenumber" name="263" href="#263">263</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="264" href="#264">264</a>     @Override
<a class="jxr_linenumber" name="265" href="#265">265</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">char</strong> getListDelimiter()
<a class="jxr_linenumber" name="266" href="#266">266</a>     {
<a class="jxr_linenumber" name="267" href="#267">267</a>         <strong class="jxr_keyword">return</strong> (parent instanceof AbstractConfiguration) ? ((AbstractConfiguration) parent)
<a class="jxr_linenumber" name="268" href="#268">268</a>                 .getListDelimiter()
<a class="jxr_linenumber" name="269" href="#269">269</a>                 : <strong class="jxr_keyword">super</strong>.getListDelimiter();
<a class="jxr_linenumber" name="270" href="#270">270</a>     }
<a class="jxr_linenumber" name="271" href="#271">271</a> 
<a class="jxr_linenumber" name="272" href="#272">272</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="273" href="#273">273</a> <em class="jxr_javadoccomment">     * Sets the list delimiter. If the parent configuration supports this</em>
<a class="jxr_linenumber" name="274" href="#274">274</a> <em class="jxr_javadoccomment">     * feature, the delimiter will be set at the parent.</em>
<a class="jxr_linenumber" name="275" href="#275">275</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="276" href="#276">276</a> <em class="jxr_javadoccomment">     * @param delim the new list delimiter</em>
<a class="jxr_linenumber" name="277" href="#277">277</a> <em class="jxr_javadoccomment">     * @since 1.4</em>
<a class="jxr_linenumber" name="278" href="#278">278</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="279" href="#279">279</a>     @Override
<a class="jxr_linenumber" name="280" href="#280">280</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setListDelimiter(<strong class="jxr_keyword">char</strong> delim)
<a class="jxr_linenumber" name="281" href="#281">281</a>     {
<a class="jxr_linenumber" name="282" href="#282">282</a>         <strong class="jxr_keyword">if</strong> (parent instanceof AbstractConfiguration)
<a class="jxr_linenumber" name="283" href="#283">283</a>         {
<a class="jxr_linenumber" name="284" href="#284">284</a>             ((<a href="../../../../org/apache/commons/configuration/AbstractConfiguration.html">AbstractConfiguration</a>) parent).setListDelimiter(delim);
<a class="jxr_linenumber" name="285" href="#285">285</a>         }
<a class="jxr_linenumber" name="286" href="#286">286</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="287" href="#287">287</a>         {
<a class="jxr_linenumber" name="288" href="#288">288</a>             <strong class="jxr_keyword">super</strong>.setListDelimiter(delim);
<a class="jxr_linenumber" name="289" href="#289">289</a>         }
<a class="jxr_linenumber" name="290" href="#290">290</a>     }
<a class="jxr_linenumber" name="291" href="#291">291</a> 
<a class="jxr_linenumber" name="292" href="#292">292</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="293" href="#293">293</a> <em class="jxr_javadoccomment">     * Returns a flag whether string properties should be checked for list</em>
<a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment">     * delimiter characters. This implementation ensures that this flag is kept</em>
<a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment">     * in sync with the parent configuration if this object supports this</em>
<a class="jxr_linenumber" name="296" href="#296">296</a> <em class="jxr_javadoccomment">     * feature.</em>
<a class="jxr_linenumber" name="297" href="#297">297</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="298" href="#298">298</a> <em class="jxr_javadoccomment">     * @return the delimiter parsing disabled flag</em>
<a class="jxr_linenumber" name="299" href="#299">299</a> <em class="jxr_javadoccomment">     * @since 1.4</em>
<a class="jxr_linenumber" name="300" href="#300">300</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="301" href="#301">301</a>     @Override
<a class="jxr_linenumber" name="302" href="#302">302</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isDelimiterParsingDisabled()
<a class="jxr_linenumber" name="303" href="#303">303</a>     {
<a class="jxr_linenumber" name="304" href="#304">304</a>         <strong class="jxr_keyword">return</strong> (parent instanceof AbstractConfiguration) ? ((AbstractConfiguration) parent)
<a class="jxr_linenumber" name="305" href="#305">305</a>                 .isDelimiterParsingDisabled()
<a class="jxr_linenumber" name="306" href="#306">306</a>                 : <strong class="jxr_keyword">super</strong>.isDelimiterParsingDisabled();
<a class="jxr_linenumber" name="307" href="#307">307</a>     }
<a class="jxr_linenumber" name="308" href="#308">308</a> 
<a class="jxr_linenumber" name="309" href="#309">309</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="310" href="#310">310</a> <em class="jxr_javadoccomment">     * Sets a flag whether list parsing is disabled. This implementation will</em>
<a class="jxr_linenumber" name="311" href="#311">311</a> <em class="jxr_javadoccomment">     * also set the flag at the parent configuration if this object supports</em>
<a class="jxr_linenumber" name="312" href="#312">312</a> <em class="jxr_javadoccomment">     * this feature.</em>
<a class="jxr_linenumber" name="313" href="#313">313</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="314" href="#314">314</a> <em class="jxr_javadoccomment">     * @param delimiterParsingDisabled the delimiter parsing disabled flag</em>
<a class="jxr_linenumber" name="315" href="#315">315</a> <em class="jxr_javadoccomment">     * @since 1.4</em>
<a class="jxr_linenumber" name="316" href="#316">316</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="317" href="#317">317</a>     @Override
<a class="jxr_linenumber" name="318" href="#318">318</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDelimiterParsingDisabled(<strong class="jxr_keyword">boolean</strong> delimiterParsingDisabled)
<a class="jxr_linenumber" name="319" href="#319">319</a>     {
<a class="jxr_linenumber" name="320" href="#320">320</a>         <strong class="jxr_keyword">if</strong> (parent instanceof AbstractConfiguration)
<a class="jxr_linenumber" name="321" href="#321">321</a>         {
<a class="jxr_linenumber" name="322" href="#322">322</a>             ((<a href="../../../../org/apache/commons/configuration/AbstractConfiguration.html">AbstractConfiguration</a>) parent)
<a class="jxr_linenumber" name="323" href="#323">323</a>                     .setDelimiterParsingDisabled(delimiterParsingDisabled);
<a class="jxr_linenumber" name="324" href="#324">324</a>         }
<a class="jxr_linenumber" name="325" href="#325">325</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="326" href="#326">326</a>         {
<a class="jxr_linenumber" name="327" href="#327">327</a>             <strong class="jxr_keyword">super</strong>.setDelimiterParsingDisabled(delimiterParsingDisabled);
<a class="jxr_linenumber" name="328" href="#328">328</a>         }
<a class="jxr_linenumber" name="329" href="#329">329</a>     }
<a class="jxr_linenumber" name="330" href="#330">330</a> 
<a class="jxr_linenumber" name="331" href="#331">331</a> 
<a class="jxr_linenumber" name="332" href="#332">332</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="333" href="#333">333</a> <em class="jxr_javadoccomment">     * A specialized iterator to be returned by the {@code getKeys()}</em>
<a class="jxr_linenumber" name="334" href="#334">334</a> <em class="jxr_javadoccomment">     * methods. This implementation wraps an iterator from the parent</em>
<a class="jxr_linenumber" name="335" href="#335">335</a> <em class="jxr_javadoccomment">     * configuration. The keys returned by this iterator are correspondingly</em>
<a class="jxr_linenumber" name="336" href="#336">336</a> <em class="jxr_javadoccomment">     * transformed.</em>
<a class="jxr_linenumber" name="337" href="#337">337</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="338" href="#338">338</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/SubsetConfiguration.html">SubsetIterator</a> <strong class="jxr_keyword">implements</strong> Iterator&lt;String&gt;
<a class="jxr_linenumber" name="339" href="#339">339</a>     {
<a class="jxr_linenumber" name="340" href="#340">340</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores the wrapped iterator. */</em>
<a class="jxr_linenumber" name="341" href="#341">341</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Iterator&lt;String&gt; parentIterator;
<a class="jxr_linenumber" name="342" href="#342">342</a> 
<a class="jxr_linenumber" name="343" href="#343">343</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="344" href="#344">344</a> <em class="jxr_javadoccomment">         * Creates a new instance of {@code SubsetIterator} and</em>
<a class="jxr_linenumber" name="345" href="#345">345</a> <em class="jxr_javadoccomment">         * initializes it with the parent iterator.</em>
<a class="jxr_linenumber" name="346" href="#346">346</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="347" href="#347">347</a> <em class="jxr_javadoccomment">         * @param it the iterator of the parent configuration</em>
<a class="jxr_linenumber" name="348" href="#348">348</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="349" href="#349">349</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/SubsetConfiguration.html">SubsetIterator</a>(Iterator&lt;String&gt; it)
<a class="jxr_linenumber" name="350" href="#350">350</a>         {
<a class="jxr_linenumber" name="351" href="#351">351</a>             parentIterator = it;
<a class="jxr_linenumber" name="352" href="#352">352</a>         }
<a class="jxr_linenumber" name="353" href="#353">353</a> 
<a class="jxr_linenumber" name="354" href="#354">354</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="355" href="#355">355</a> <em class="jxr_javadoccomment">         * Checks whether there are more elements. Delegates to the parent</em>
<a class="jxr_linenumber" name="356" href="#356">356</a> <em class="jxr_javadoccomment">         * iterator.</em>
<a class="jxr_linenumber" name="357" href="#357">357</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="358" href="#358">358</a> <em class="jxr_javadoccomment">         * @return a flag whether there are more elements</em>
<a class="jxr_linenumber" name="359" href="#359">359</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="360" href="#360">360</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasNext()
<a class="jxr_linenumber" name="361" href="#361">361</a>         {
<a class="jxr_linenumber" name="362" href="#362">362</a>             <strong class="jxr_keyword">return</strong> parentIterator.hasNext();
<a class="jxr_linenumber" name="363" href="#363">363</a>         }
<a class="jxr_linenumber" name="364" href="#364">364</a> 
<a class="jxr_linenumber" name="365" href="#365">365</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="366" href="#366">366</a> <em class="jxr_javadoccomment">         * Returns the next element in the iteration. This is the next key from</em>
<a class="jxr_linenumber" name="367" href="#367">367</a> <em class="jxr_javadoccomment">         * the parent configuration, transformed to correspond to the point of</em>
<a class="jxr_linenumber" name="368" href="#368">368</a> <em class="jxr_javadoccomment">         * view of this subset configuration.</em>
<a class="jxr_linenumber" name="369" href="#369">369</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="370" href="#370">370</a> <em class="jxr_javadoccomment">         * @return the next element</em>
<a class="jxr_linenumber" name="371" href="#371">371</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="372" href="#372">372</a>         <strong class="jxr_keyword">public</strong> String next()
<a class="jxr_linenumber" name="373" href="#373">373</a>         {
<a class="jxr_linenumber" name="374" href="#374">374</a>             <strong class="jxr_keyword">return</strong> getChildKey(parentIterator.next());
<a class="jxr_linenumber" name="375" href="#375">375</a>         }
<a class="jxr_linenumber" name="376" href="#376">376</a> 
<a class="jxr_linenumber" name="377" href="#377">377</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="378" href="#378">378</a> <em class="jxr_javadoccomment">         * Removes the current element from the iteration. Delegates to the</em>
<a class="jxr_linenumber" name="379" href="#379">379</a> <em class="jxr_javadoccomment">         * parent iterator.</em>
<a class="jxr_linenumber" name="380" href="#380">380</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="381" href="#381">381</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> remove()
<a class="jxr_linenumber" name="382" href="#382">382</a>         {
<a class="jxr_linenumber" name="383" href="#383">383</a>             parentIterator.remove();
<a class="jxr_linenumber" name="384" href="#384">384</a>         }
<a class="jxr_linenumber" name="385" href="#385">385</a>     }
<a class="jxr_linenumber" name="386" href="#386">386</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

